Fzzy Config/me.fzzyhmstrs.fzzy_config.screen.widget/DynamicListWidget/Visibility

Visibility

enum Visibility : Enum<DynamicListWidget.Visibility> , DynamicListWidget.VisibilityProvider

Enum defining how the user sees and can interact with an entry.

visible: 1. Whether the entry is visible. A non-visible entry will take up 0 width in the list (effectively removed from the list, visually)
skip: 2. Whether the entry should be skipped when searching
selectable: 4. Whether the user can interact with the entry
group: 8. Whether the entry belongs to a group
repeatable: 16. Whether this visibility can be applied to an entry more than once
searched: 32. Visibility applied as a result of searching
closed: 64. Visibility applied from an initially-closed state
filtered: 128. Entry has been excluded by a search

Author

fzzyhmstrs

Since

0.6.0, uses flags 0.6.8

Parameters

affectedBy

Predicate to determine if this visibility is affected by another

Entries

VISIBLE

Standard visibility. The Entry can be seen, searched, and interacted with.

VISIBLE_SEARCHED

Visible because it contains valid search results inside it.

HIDDEN

Entry hidden by a user action like toggling a group, or some visibility button. Not visible nor selectable, but searchable (in case the user reverses the hidden state after searching)

HIDDEN_SEARCHED

Hidden because it contains valid search results inside it, but it's group is currently collapsed.

HIDDEN_CLOSED

Entry hidden initially by an initial-closed state

FILTERED

Entry filtered by searching. Not visible nor selectable

GROUP_VISIBLE

Visible entry that represents a group heading

GROUP_VISIBLE_SEARCHED

Visible entry that represents a group heading

GROUP_VISIBLE_CLOSED

Visible entry that represents a group heading, but should be "closed"/"collapsed" by default

GROUP_FILTERED

Filtered entry that represents a group heading. Filtering is usually done with a search.

GROUP_HIDDEN

Hidden entry that represents a group heading. Hiding is usually done with a button or other toggle.

GROUP_HIDDEN_SEARCHED

Hidden entry that represents a group heading. This group has valid search results inside it, hence the searched flag

GROUP_HIDDEN_CLOSED

Hidden entry that represents a group heading. Group hidden initially by an initial-closed state. Hiding is usually done with a button or other toggle.

GROUP_DISABLED

A disabled group heading, typically caused by a layout error.

HEADER_VISIBLE

A header entry. Always visible, skipped in searching, and not selectable. Visibility of headers can't be changed.

Types

Companion

object Companion

Properties

affectedBy

val affectedBy: Predicate<DynamicListWidget.Visibility>

closed

val closed: Boolean

entries

val entries: EnumEntries<DynamicListWidget.Visibility>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

filtered

val filtered: Boolean

val group: Boolean

val name: String

val ordinal: Int

val repeatable: Boolean

searched

val searched: Boolean

selectable

val selectable: Boolean

skip

val skip: Boolean

visible

val visible: Boolean

Functions

get

open override fun get(): DynamicListWidget.Visibility

Returns the entries current Visibility status

getRoot

open fun getRoot(): DynamicListWidget.Visibility

Returns the entries root Visibility status

valueOf

fun valueOf(value: String): DynamicListWidget.Visibility

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<DynamicListWidget.Visibility>

Returns an array containing the constants of this enum type, in the order they're declared.